eeprom14.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef EEPROM14_H
#define EEPROM14_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define EEPROM14_MEM_ADDR_START                     0x0000
#define EEPROM14_MEM_ADDR_END                       0xFFFF
#define EEPROM14_MEM_PAGE_SIZE                      128

#define EEPROM14_DEVICE_ADDRESS_A2A1A0_000          0x50
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_001          0x51
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_010          0x52
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_011          0x53
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_100          0x54
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_101          0x55
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_110          0x56
#define EEPROM14_DEVICE_ADDRESS_A2A1A0_111          0x57
 // eeprom14_set



#define EEPROM14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM );
 // eeprom14_map // eeprom14

typedef struct
{
    // Output pins
    digital_out_t wp;           
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
} eeprom14_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t wp;              
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} eeprom14_cfg_t;

typedef enum
{
    EEPROM14_OK = 0,
    EEPROM14_ERROR = -1
 
} eeprom14_return_value_t;


void eeprom14_cfg_setup ( eeprom14_cfg_t *cfg );

err_t eeprom14_init ( eeprom14_t *ctx, eeprom14_cfg_t *cfg );

err_t eeprom14_write_memory ( eeprom14_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len );

err_t eeprom14_read_memory ( eeprom14_t *ctx, uint16_t address, uint8_t *data_out, uint16_t len );

void eeprom14_write_enable ( eeprom14_t *ctx );

void eeprom14_write_protect ( eeprom14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EEPROM14_H
 // eeprom14
 
// ------------------------------------------------------------------------ END